
































  
  


  

  
  	
  

  

	
	

	
	
	
	
	




  
















	
	
	
	
	
	
	
	
	
	
  
  


	


	
	
	
	
	
	
	
	
	
	
	
	
	
	
	
	
	
	




    
  






  
    
  




	
	
	
	
	



<!--NewPage-->
<HTML>

<!-- Mirrored from delerium:8503/cfcdoc/content.cfm?file=C%3A%5CInetpub%5Cwwwroot%5Ctransfer%2Droot%5Ctransfer%5Ccom%5Ccollections%5CQueryCache%2Ecfc by HTTrack Website Copier/3.x [XR&CO'2006], Sat, 07 Apr 2007 03:16:33 GMT -->
<!-- Added by HTTrack --><meta http-equiv="content-type" content="text/html;charset=UTF-8"><!-- /Added by HTTrack -->
<HEAD>

<!-- Generated by CFDoc on 07-Apr-2007 01:16 PM -->

<LINK REL ="stylesheet" TYPE="text/css" HREF="stylesheet.css" TITLE="Style">
</HEAD>
<BODY>


	



<HR>
<!-- ======== START OF CLASS DATA ======== -->

<div style="float:left;">

<a href="default.html" style="float: right;">Documentation home page</a>
</div>
<H2>
<span style="font-size: smaller">
<a href="componentse036.html" target="components">transfer.com.collections</a>
</span>
<BR>
Component QueryCache</H2>


<PRE>
<B>transfer.com.collections.QueryCache</B>
</PRE>


<HR>
A query caching mechanism


<HR>

<P>


<!-- ========== PROPERTY SUMMARY =========== -->

<A NAME="property_summary"><!-- --></A>






<!-- ========== METHOD SUMMARY =========== -->




<A NAME="method_summary"><!-- --></A>

<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">

<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=2><FONT SIZE="+2">
<B>Method Summary</B></FONT></TD>
</TR>











	





	





	





	





	





	





	





	





	



	<TR BGCOLOR="eeeeff" CLASS="TableRowColorConstructor">
	<TD ALIGN="right" VALIGN="top" WIDTH="1%">
	<CODE>public <a href="content39ea.html" target="_self">QueryCache</a></CODE></TD>
	<TD><CODE><B><A HREF="#init()">init</A></B>()</CODE>
	
		<BR>
		&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constructor
	</TD>
	</TR>
	

	<TR BGCOLOR="white" CLASS="TableRowColor">
	<TD ALIGN="right" VALIGN="top" WIDTH="1%">
	<CODE>public <a href="nativetypes.html#detail_void" target="_self">void</a></CODE></TD>
	<TD><CODE><B><A HREF="#cacheQuery()">cacheQuery</A></B>(<a href="nativetypes.html#detail_query">query</a> query,&nbsp;<a href="nativetypes.html#detail_string">string</a> key,&nbsp;[<a href="nativetypes.html#detail_date">date</a> expireDateTime="#DateAdd('y', 10, Now())#"])</CODE>
	
		<BR>
		&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Caches a given query
	
	
	</TD>
	</TR>
	
	<TR BGCOLOR="white" CLASS="TableRowColor">
	<TD ALIGN="right" VALIGN="top" WIDTH="1%">
	<CODE>public <a href="nativetypes.html#detail_boolean" target="_self">boolean</a></CODE></TD>
	<TD><CODE><B><A HREF="#checkQuery()">checkQuery</A></B>(<a href="nativetypes.html#detail_string">string</a> key)</CODE>
	
		<BR>
		&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns true if the query exists, and hasn't expired
	
	
	</TD>
	</TR>
	
	<TR BGCOLOR="white" CLASS="TableRowColor">
	<TD ALIGN="right" VALIGN="top" WIDTH="1%">
	<CODE>private <a href="nativetypes.html#detail_struct" target="_self">struct</a></CODE></TD>
	<TD><CODE><B><A HREF="#getExpireyCollection()">getExpireyCollection</A></B>()</CODE>
	
	
	</TD>
	</TR>
	
	<TR BGCOLOR="white" CLASS="TableRowColor">
	<TD ALIGN="right" VALIGN="top" WIDTH="1%">
	<CODE>public <a href="nativetypes.html#detail_query" target="_self">query</a></CODE></TD>
	<TD><CODE><B><A HREF="#getQuery()">getQuery</A></B>(<a href="nativetypes.html#detail_string">string</a> key)</CODE>
	
		<BR>
		&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Retrieves a query from the cache
	
	
	</TD>
	</TR>
	
	<TR BGCOLOR="white" CLASS="TableRowColor">
	<TD ALIGN="right" VALIGN="top" WIDTH="1%">
	<CODE>private <a href="nativetypes.html#detail_struct" target="_self">struct</a></CODE></TD>
	<TD><CODE><B><A HREF="#getQueryCollection()">getQueryCollection</A></B>()</CODE>
	
	
	</TD>
	</TR>
	
	<TR BGCOLOR="white" CLASS="TableRowColor">
	<TD ALIGN="right" VALIGN="top" WIDTH="1%">
	<CODE>public <a href="nativetypes.html#detail_void" target="_self">void</a></CODE></TD>
	<TD><CODE><B><A HREF="#removeQuery()">removeQuery</A></B>(<a href="nativetypes.html#detail_string">string</a> key)</CODE>
	
		<BR>
		&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;removes a query from the cache
	
	
	</TD>
	</TR>
	
	<TR BGCOLOR="white" CLASS="TableRowColor">
	<TD ALIGN="right" VALIGN="top" WIDTH="1%">
	<CODE>private <a href="nativetypes.html#detail_void" target="_self">void</a></CODE></TD>
	<TD><CODE><B><A HREF="#setExpireyCollection()">setExpireyCollection</A></B>(<a href="nativetypes.html#detail_struct">struct</a> ExpireyCollection)</CODE>
	
	
	</TD>
	</TR>
	
	<TR BGCOLOR="white" CLASS="TableRowColor">
	<TD ALIGN="right" VALIGN="top" WIDTH="1%">
	<CODE>private <a href="nativetypes.html#detail_void" target="_self">void</a></CODE></TD>
	<TD><CODE><B><A HREF="#setQueryCollection()">setQueryCollection</A></B>(<a href="nativetypes.html#detail_struct">struct</a> QueryCollection)</CODE>
	
	
	</TD>
	</TR>
	
</TABLE>



&nbsp;
<P>



<!-- ============ METHOD DETAIL ========== -->


<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=1><FONT SIZE="+2">
<B>Method Detail</B></FONT></TD>
</TR>
</TABLE>












<A NAME="cacheQuery()"><!-- --></A><H3>
cacheQuery</H3>

<PRE>
public <A HREF="nativetypes.html#detail_void" title="">void</A> <B>cacheQuery</B>(<a href="nativetypes.html#detail_query">query</a> query,&nbsp;<a href="nativetypes.html#detail_string">string</a> key,&nbsp;[<a href="nativetypes.html#detail_date">date</a> expireDateTime="#DateAdd('y', 10, Now())#"])</PRE>
<DL>
  <DD>
  	
  	
		Caches a given query
	    <P>
	
	
		<DL>
		  <DT><B>Parameters:</B></DT>
			
			  <DD><code><a href="nativetypes.html#detail_query">query</a> query</code> - The query to cache</DD>
			
			  <DD><code><a href="nativetypes.html#detail_string">string</a> key</code> - The unique key to store the query under</DD>
			
			  <DD><code>[<a href="nativetypes.html#detail_date">date</a> expireDateTime="#DateAdd('y', 10, Now())#"]</code> - The date-time that the query should expire, default of 'never'</DD>
			
		</DL>
	
	
    
  </DD>
</DL>
<HR>




<A NAME="checkQuery()"><!-- --></A><H3>
checkQuery</H3>

<PRE>
public <A HREF="nativetypes.html#detail_boolean" title="">boolean</A> <B>checkQuery</B>(<a href="nativetypes.html#detail_string">string</a> key)</PRE>
<DL>
  <DD>
  	
  	
		Returns true if the query exists, and hasn't expired
	    <P>
	
	
		<DL>
		  <DT><B>Parameters:</B></DT>
			
			  <DD><code><a href="nativetypes.html#detail_string">string</a> key</code> - The unique key to store the query under</DD>
			
		</DL>
	
	
    
  </DD>
</DL>
<HR>




<A NAME="getExpireyCollection()"><!-- --></A><H3>
getExpireyCollection</H3>

<PRE>
private <A HREF="nativetypes.html#detail_struct" title="">struct</A> <B>getExpireyCollection</B>()</PRE>
<DL>
  <DD>
  	
  	
	
	
    
  </DD>
</DL>
<HR>




<A NAME="getQuery()"><!-- --></A><H3>
getQuery</H3>

<PRE>
public <A HREF="nativetypes.html#detail_query" title="">query</A> <B>getQuery</B>(<a href="nativetypes.html#detail_string">string</a> key)</PRE>
<DL>
  <DD>
  	
  	
		Retrieves a query from the cache
	    <P>
	
	
		<DL>
		  <DT><B>Parameters:</B></DT>
			
			  <DD><code><a href="nativetypes.html#detail_string">string</a> key</code> - The unique key the query is stored under</DD>
			
		</DL>
	
	
    
  </DD>
</DL>
<HR>




<A NAME="getQueryCollection()"><!-- --></A><H3>
getQueryCollection</H3>

<PRE>
private <A HREF="nativetypes.html#detail_struct" title="">struct</A> <B>getQueryCollection</B>()</PRE>
<DL>
  <DD>
  	
  	
	
	
    
  </DD>
</DL>
<HR>




<A NAME="init()"><!-- --></A><H3>
init</H3>

<PRE>
public <A HREF="content39ea.html" title="">QueryCache</A> <B>init</B>()</PRE>
<DL>
  <DD>
  	
  	
		Constructor
	    <P>
	
	
	
    
  </DD>
</DL>
<HR>




<A NAME="removeQuery()"><!-- --></A><H3>
removeQuery</H3>

<PRE>
public <A HREF="nativetypes.html#detail_void" title="">void</A> <B>removeQuery</B>(<a href="nativetypes.html#detail_string">string</a> key)</PRE>
<DL>
  <DD>
  	
  	
		removes a query from the cache
	    <P>
	
	
		<DL>
		  <DT><B>Parameters:</B></DT>
			
			  <DD><code><a href="nativetypes.html#detail_string">string</a> key</code> - The unique key the query is stored under</DD>
			
		</DL>
	
	
    
  </DD>
</DL>
<HR>




<A NAME="setExpireyCollection()"><!-- --></A><H3>
setExpireyCollection</H3>

<PRE>
private <A HREF="nativetypes.html#detail_void" title="">void</A> <B>setExpireyCollection</B>(<a href="nativetypes.html#detail_struct">struct</a> ExpireyCollection)</PRE>
<DL>
  <DD>
  	
  	
	
		<DL>
		  <DT><B>Parameters:</B></DT>
			
			  <DD><code><a href="nativetypes.html#detail_struct">struct</a> ExpireyCollection</code></DD>
			
		</DL>
	
	
    
  </DD>
</DL>
<HR>




<A NAME="setQueryCollection()"><!-- --></A><H3>
setQueryCollection</H3>

<PRE>
private <A HREF="nativetypes.html#detail_void" title="">void</A> <B>setQueryCollection</B>(<a href="nativetypes.html#detail_struct">struct</a> QueryCollection)</PRE>
<DL>
  <DD>
  	
  	
	
		<DL>
		  <DT><B>Parameters:</B></DT>
			
			  <DD><code><a href="nativetypes.html#detail_struct">struct</a> QueryCollection</code></DD>
			
		</DL>
	
	
    
  </DD>
</DL>
<HR>







</BODY>

<!-- Mirrored from delerium:8503/cfcdoc/content.cfm?file=C%3A%5CInetpub%5Cwwwroot%5Ctransfer%2Droot%5Ctransfer%5Ccom%5Ccollections%5CQueryCache%2Ecfc by HTTrack Website Copier/3.x [XR&CO'2006], Sat, 07 Apr 2007 03:16:33 GMT -->
<!-- Added by HTTrack --><meta http-equiv="content-type" content="text/html;charset=UTF-8"><!-- /Added by HTTrack -->
</HTML>